home *** CD-ROM | disk | FTP | other *** search
/ Artworx CD [Amiga] / Artworx CD - Amiga Version (Weird Science) (1995).iso / ecs / artists / schenck / qf.txt < prev    next >
Text File  |  1988-12-19  |  11KB  |  242 lines
  1.  
  2.                            QuickFlix Rev 0.12
  3.  
  4.     Copyright (c) 1987  Jeff Kunzelman, Rodney Iwashina, Takeshi Suganuma
  5.  
  6.   If you like this program please feel free to send a donation ($10.00)
  7.   payable to:
  8.           Rodney Iwashina  11333 Yolanda Ave.  Northridge, Ca. 91326
  9.  
  10.   You can make as many copies of this program as you like and give it to
  11.   all your friends, on the condition that you abide by these guidelines:
  12.  
  13.      The copy(s) (including documentation) must remain unmodified
  14.      and intact.
  15.      The copy(s) cannot be sold for money or profit, except by the
  16.      original authors.
  17.      At the time of transfer, the new recipient(s) agree(s) to the above
  18.      guidelines.
  19.  
  20.   Suggestions and comments of any kind can be sent to the above address
  21.   or through CIS (76224,102).  We hope that you enjoy this shareware!
  22.  
  23.  
  24. Introduction:
  25.  
  26.         QuickFlix is an IFF slideshow and cel animation program.
  27.         It takes full advantage of the Amiga's multi-tasking operating
  28.         system by creating multiple tasks to manage each of its
  29.         resources, communicating via executive messages and ports,
  30.         and sharing data in a common memory pool.  QuickFlix supports
  31.         the LO-RES, HI-RES, NON-INTERLACE, INTERLACE, and HAM modes of
  32.         the Amiga.  QuickFlix can be commanded to run independently
  33.         or can be triggered by an external source.  A stand-alone
  34.         slideshow or animation sequence can be gernerated when
  35.         QuickFlix is run independently.  External triggering allows a
  36.         user to interactively control the slideshow or animation.
  37.         QuickFlix implements a caching system that pre-loads pictures
  38.         into memory.  This feature allows QuickFlix to support the
  39.         rapid frame rate necessary for cel animation.
  40.  
  41.  
  42. CLI Usage:
  43.  
  44.         QuickFlix [-t<tick rate>] [-l<log file>] <script file> ...
  45.  
  46.         <script file> is the name of the script file containing the
  47.                 names of the pictures, the special effects information,
  48.                 and the timing information.  All timing information is
  49.                 expressed in number of ticks.  Multiple script files
  50.                 may be chained together by specifying them on the
  51.                 command line.
  52.  
  53.         -t<tick rate> indicates the timer tick rate, where <tick rate>
  54.                 is a decimal integer from 0 to 60, corresponding to tick
  55.                 rates of 0 to 60 ticks per second.  When the tick rate is
  56.                 set to 0, the external triggering is enabled.  This
  57.                 option defaults to 30 tick per second.
  58.  
  59.         -l<log file> designates the file to log informational and error
  60.                 messages.  If this option is not specified, no log file
  61.                 will be created.
  62.  
  63.         QuickFlix can be exited at any time by pressing the ESC key or
  64.                 <CTRL> C; holding the CTRL key down and pressing the C key.
  65.  
  66.         usage example:
  67.  
  68.                 QuickFlix -t24 -llogfile script
  69.  
  70.                 This example will read the script information from the
  71.                 file "script", the tick rate will be 24 ticks per
  72.                 second, and the log information will be written into the
  73.                 file "logfile".
  74.  
  75.  
  76. Workbench Usage:
  77.  
  78.         QuickFlix can also be invoked from the Workbench.  A single
  79.         script can be invoked by double-clicking on the desired script
  80.         file icon.  A single script file can also be invoked by
  81.         shift-clicking (holding the SHIFT key down and clicking on the
  82.         the icon) the desired script file icon, then double-clicking
  83.         on the QuickFlix icon.  Multiple scripts can be invoked by
  84.         shift-clicking all desired script file icons, then double-clicking
  85.         on the QuickFlix icon.  When multiple scripts are selected, the
  86.         'tool types' information from the first shift-selected script
  87.         will be used for all subsequent scripts.
  88.  
  89.         Valid Tool Types:
  90.  
  91.              n=<anything> (no seperate fast memory cache)
  92.              l=<log file name>
  93.              t=<ticks per second> (t=0 = use joystick)
  94.  
  95.              All others will be ignored.
  96.  
  97.  
  98. Script Format:
  99.  
  100.         Entries in the script file must conform to the following format:
  101.  
  102.         s <picture file> - any IFF picture file
  103.  
  104.         n <ticks> - Switch to next picture in script in <ticks> ticks
  105.                 where <ticks> is a positive decimal integer.  If
  106.                 the last picture in the script includes this entry,
  107.                 QuickFlix will exit when the switch occurs, otherwise
  108.                 the last picture will remain on the screen until QuickFlix
  109.                 is manually exited via an ESC or <CTRL> C.
  110.  
  111.         i <start ticks> <end ticks> <interval ticks> <red> <green> <blue> -
  112.                 Fade in the current picture starting at <start ticks> ticks
  113.                 after the picture is switched in, end fade at <end ticks>
  114.                 ticks after the picture is switched in, fade at intervals
  115.                 of <interval ticks> ticks, and fade in from color <red>,
  116.                 <green>, <blue> where all tick values are positive decimal
  117.                 integers and all colors are hexidecimal values from 0 to f.
  118.  
  119.         o <start ticks> <end ticks> <interval ticks> <red> <green> <blue> -
  120.                 Fade out the current picture starting at <start ticks> ticks
  121.                 after the picture is switched in, end fade at <end ticks>
  122.                 ticks after the picture is switched in, fade at intervals
  123.                 of <interval ticks> ticks, and fade out to color <red>,
  124.                 <green>, <blue> where all tick values are positive decimal
  125.                 integers and all colors are hexidecimal values from 0 to f.
  126.  
  127.         c <start ticks> <end ticks> <delay factor> - Cycle color ranges
  128.                 starting at <start ticks> ticks after the picture is
  129.                 switched in, end cycling at <end ticks> ticks after the
  130.                 picture is swithced in, with a delay factor of
  131.                 <delay factor> applied to the color cycle rate where
  132.                 all values are positive decimal integers.  The color
  133.                 cycle ranges and rates are read from the IFF file.
  134.  
  135.         script example:
  136.  
  137.                 s picture1
  138.                 n 40
  139.                 i 0 0 1 0 0 0
  140.                 o 20 0 1 f f f
  141.                 s picture2
  142.                 n 60
  143.                 i 0 0 2 f f f
  144.                 o 30 0 2 0 0 0
  145.                 s picture3
  146.                 n 80
  147.                 i 0 0 1 0 0 f
  148.                 o 60 0 1 0 0 f
  149.                 c 0 0 1
  150.  
  151.                 This example will show three pictures.  The first picture
  152.                 is "picture1".  It will be shown for 40 ticks, fade in from
  153.                 black when it is switched in, and fade out to white 20
  154.                 ticks from the time it is switched in.  The second picture
  155.                 is "picture2".  I will be shwon for 60 ticks, fade in from
  156.                 white when it is switched in, and fade out to black 30
  157.                 ticks from the time it is switched in.  The third picture
  158.                 is "picture3".  It will be shown for 80 ticks, fade in
  159.                 from blue when the picture is switched in, fade out to blue
  160.                 60 ticks from the time it is switched in, and will color
  161.                 cycle the cycle ranges with a delay factor of 1.  QuickFlix
  162.                 will exit after showing this picture since it is the last
  163.                 one in the script and it specifies a switch.
  164.  
  165.  
  166. Cel Animation:
  167.  
  168.         Given the architecture of the system, cel animation becomes
  169.         a simple exercise of script manipulation.  The pictures that
  170.         make up the animation can be entered to be shown for a short
  171.         nubmer of ticks, and the tick rate can be adjusted to a reasonable
  172.         rate for animation.  The cache allows rapid switching of pictures
  173.         as long as the pictures are in the cache, otherwise the pictures
  174.         have to be read from the disk.  The cache will hold about 5
  175.         320x200x5 (typical DeluxePaint) pictures on a 512K Amiga, about
  176.         40 on a 2.5M Amiga.  These numbers will vary depending on the
  177.         resolution, interlace, and number of bit planes, because the cache
  178.         is memory dependent.  The more memory, the better, but if the
  179.         display rate exceeds the cache fill rate, the cache will
  180.         eventually get behind, causing a pause in the animation.  There
  181.         are a number of things you can do to optimize animations.
  182.         Additional memory will result in a larger cache and therefore
  183.         a higher cache hit rate.  A hard disk will increase the transfer
  184.         rate of pictures from disk to cache.  Pictures with fewer bit
  185.         planes will decrease the amount of memory needed for each picture.
  186.         Repeating short sequences of pictures in the script will allow
  187.         a higher cache hit rate.  Color cycling can be used to simulate
  188.         animation.
  189.  
  190.  
  191. External Triggering:
  192.  
  193.         External triggering allows a user to interactively control the
  194.         slideshow or animation.
  195.  
  196.         A joystick connected to port 2 of the Amiga can be used for
  197.         interactive control.  The joystick can increase or decrease
  198.         the tick rate by pushing the joystick up or pulling it back.
  199.         Pressing the joystick button at any time will enable the
  200.         single-step mode.  In this mode, each button press will cause
  201.         a timer tick to occur.  Continuous timer tick mode is re-enabled
  202.         by moving the joystick up or down.  Moving the joystick to the
  203.         right will switch to the next picture in the script.
  204.  
  205.  
  206. Known Problems:
  207.  
  208.         The picture swithing rate does not keep up with the tick rate
  209.         at tick rates exceeding about 24 frames per second.
  210.  
  211.         Fades and color cycling effects do not work on HAM pictures.
  212.  
  213.  
  214. Future Enhancements:
  215.  
  216.         We are continuously trying to improve our product.  Suggestions
  217.         and comments are more than welcome.  We would like to know what
  218.         type of application you are using QuickFlix for and any
  219.         enhancements that you would like to see incorporated into it.
  220.         Our current list of enhancements follow.
  221.  
  222.                 Repeat and reverse for script
  223.  
  224.                 External device synchronization
  225.  
  226.                 Additional special effects
  227.  
  228.  
  229. Notes:
  230.  
  231.        The logfile output option is extremly handy to determine
  232.        problems.  The logfile will keep a trace of the general
  233.        operation of the QuickFlix system.  Information will include
  234.        cache statistics and errors.  The errors will indicate
  235.        bad IFF files, memory resource problems, etc.  A good place
  236.        to put the logfile is in the ram disk (i.e. -l ram:logfile).
  237.        The log file will not be created with an icon so it must be
  238.        accessed from the CLI.
  239.  
  240.        We really are looking for comments about this program, so
  241.        drop us a note and tell us what you think.
  242.